List of Connected Hubs

Request

Filters and returns Connected Hub records for current Primary Hub with basic info.
Request valid only in scope of Primary Hub and can't be used in scope of a Connected Hub.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of Primary Hub for requested Connected Hub.

Query

qstring

Query string

sort_propstring

Determines which property results should be sorted by.

Default:"position"

Enum:"position""created_at""start_time"

sort_dirstring

Determines sorting direction.

Default:"asc"

Enum:"asc""desc"

pageinteger, >= 1

Requested page index.

Default:1

per_pageinteger, [ 1 .. 100 ]

A limit on the number of records to be returned.

Default:25

api_versionstring

Api version

Value:"V3-R1"

curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/connected_hubs?q=string&sort_prop=position&sort_dir=asc&page=1&per_page=25&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

current_pageinteger, >= 1

Example:1

page_countinteger, >= 1

Example:4

per_pageinteger, [ 1 .. 100 ]

Example:25

totalinteger, >= 0

Example:1024

dataArray of objects

Response

{
  "current_page": 1,
  "page_count": 4,
  "per_page": 25,
  "total": 1024,
  "data": [
    { … }
  ]
}